
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Welcome to PixieDust &#8212; PixieDust Documentation</title>
    <link rel="stylesheet" href="_static/better.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="_static/custom.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '1.0',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true,
        SOURCELINK_SUFFIX: '.txt'
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="shortcut icon" href="_static/pd_icon.ico"/>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Use PixieDust" href="use.html" />
  <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
  </head>
  <body>
    <header id="pageheader"><h1><a href="# ">
        PixieDust Documentation
    </a></h1></header>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="welcome-to-pixiedust">
<h1>Welcome to PixieDust<a class="headerlink" href="#welcome-to-pixiedust" title="Permalink to this headline">¶</a></h1>
<p><a class="reference external" href="https://github.com/ibm-cds-labs/pixiedust">PixieDust</a> is an open source Python helper library that works as an add-on to Jupyter notebooks to improve the user experience of working with data. It also fills a gap for users who have no access to configuration files when a notebook is hosted on the cloud.</p>
<p>For more details on all that PixieDust offers to users and developers, see PixieDust’s <a class="reference external" href="https://github.com/ibm-cds-labs/pixiedust/blob/master/README.md">README on GitHub</a>. For news, events, and other general resources, see <a class="reference external" href="http://ibm.biz/wdp-pixiedust">http://ibm.biz/wdp-pixiedust</a>.</p>
<p>There are two ways to dive into PixieDust:</p>
<div class='main-panel'>
<h2><a href="use.html">Use</a></h2>
<p>&nbsp;</p>
<p>Start by trying PixieDust online in a Python notebook. Or, install and work locally if you prefer. <br></p>
<a class='default-link' href='javascript:void(0)' onclick='window.location = "use.html"'>
</a>

</div>

<div class='main-panel'>
<h2><a href="develop.html">Develop</a></h2>
<p>Create your own visualizations or apps using the pixiedust extensibility APIs. If you know HTML and CSS, you can write and deliver amazing graphics and make them available to notebook users. </p>
<a href='javascript:void(0)' onclick='window.location = "develop.html"'>
    <span class='default-link'></span>
</a>

</div><div class="section" id="get-started">
<h2>Get Started<a class="headerlink" href="#get-started" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="use.html">Use PixieDust</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install.html">Install PixieDust</a></li>
<li class="toctree-l2"><a class="reference internal" href="loaddata.html">Load Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="displayapi.html">Display Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="packagemanager.html">Package Manager</a></li>
<li class="toctree-l2"><a class="reference internal" href="scalabridge.html">Use Scala in a Python Notebook</a></li>
<li class="toctree-l2"><a class="reference internal" href="sparkmonitor.html">Spark Progress Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="download.html">Download Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="logging.html">Logging</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="develop.html">Develop for PixieDust</a><ul>
<li class="toctree-l2"><a class="reference internal" href="contribute.html">Contribute</a></li>
<li class="toctree-l2"><a class="reference internal" href="writeviz.html">Write a new PixieDust Visualization</a></li>
<li class="toctree-l2"><a class="reference internal" href="renderer.html">Build a Renderer</a></li>
<li class="toctree-l2"><a class="reference internal" href="test.html">Test</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pixieapps.html">PixieApps</a><ul>
<li class="toctree-l2"><a class="reference internal" href="hello-world-pixieapp.html">Hello World</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference-pixieapp.html">Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="html-attributes-pixieapp.html">Custom HTML Attributes</a></li>
<li class="toctree-l2"><a class="reference internal" href="custom-elements-pixieapp.html">Custom Elements</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamic-values-pixieapp.html">Dynamic Values</a></li>
<li class="toctree-l2"><a class="reference internal" href="create-widget-pixieapp.html">Creating a Widget</a></li>
<li class="toctree-l2"><a class="reference internal" href="hello-world-data-pixieapp.html">Hello World with Data</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pixiegateway.html">PixieGateway</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install-pixiegateway.html">Install PixieGateway</a></li>
<li class="toctree-l2"><a class="reference internal" href="chart-sharing.html">Chart Sharing</a></li>
<li class="toctree-l2"><a class="reference internal" href="pixieapp-publishing.html">PixieApp Publishing</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="releasenotes.html">Release Notes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="1-0-4.html">1.0.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="1-0-5.html">1.0.5</a></li>
<li class="toctree-l2"><a class="reference internal" href="1-0-6.html">1.0.6</a></li>
<li class="toctree-l2"><a class="reference internal" href="1-0-7.html">1.0.7</a></li>
<li class="toctree-l2"><a class="reference internal" href="1-0-8.html">1.0.8</a></li>
<li class="toctree-l2"><a class="reference internal" href="1-0-9.html">1.0.9</a></li>
<li class="toctree-l2"><a class="reference internal" href="1-0-10.html">1.0.10</a></li>
<li class="toctree-l2"><a class="reference internal" href="1-0-11.html">1.0.11</a></li>
<li class="toctree-l2"><a class="reference internal" href="1-1.html">1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="1-1-1.html">1.1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="1-1-2.html">1.1.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="1-1-3.html">1.1.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="1-1-4.html">1.1.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="1-1-5.html">1.1.5</a></li>
<li class="toctree-l2"><a class="reference internal" href="1-1-6.html">1.1.6</a></li>
<li class="toctree-l2"><a class="reference internal" href="1-1-7.html">1.1.7</a></li>
<li class="toctree-l2"><a class="reference internal" href="1-1-8.html">1.1.8</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="use.html">Use PixieDust</a></li>
<li class="toctree-l1"><a class="reference internal" href="develop.html">Develop for PixieDust</a></li>
<li class="toctree-l1"><a class="reference internal" href="pixieapps.html">PixieApps</a></li>
<li class="toctree-l1"><a class="reference internal" href="pixiegateway.html">PixieGateway</a></li>
<li class="toctree-l1"><a class="reference internal" href="releasenotes.html">Release Notes</a></li>
</ul>

<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
  <footer id="pagefooter">&copy; 2017, IBM.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a>
      1.6.3.

  </footer>

  
  </body>
</html>